config-linux: fix format and definitely require value of masked and r… #587
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wking
reviewed
Sep 30, 2016
| @@ -552,7 +552,7 @@ Its value is either slave, private, or shared. | |||
|
|
|||
| ## Masked Paths | |||
|
|
|||
| `maskedPaths` will mask over the provided paths inside the container so that they cannot be read. | |||
| **`maskedPaths`** (array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read. The values MUST be absolute paths. | |||
There was a problem hiding this comment.
Second sentence should go on a new line.
wking
reviewed
Sep 30, 2016
| @@ -564,7 +564,7 @@ Its value is either slave, private, or shared. | |||
|
|
|||
| ## Readonly Paths | |||
|
|
|||
| `readonlyPaths` will set the provided paths as readonly inside the container. | |||
| **`readonlyPaths`** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container. The values MUST be absolute paths. | |||
There was a problem hiding this comment.
Second sentence should go on a new line.
| @@ -576,7 +576,7 @@ Its value is either slave, private, or shared. | |||
|
|
|||
| ## Mount Label | |||
|
|
|||
| `mountLabel` will set the Selinux context for the mounts in the container. | |||
| **`mountLabel`** will set the Selinux context for the mounts in the container. | |||
There was a problem hiding this comment.
This (and a number of other entries you bold) should probably also get (object, OPTIONAL).
Mashimiao
force-pushed
the
config-fix-and-value-require-paths
branch
from
67c6964
to
807c66f
Compare
wking
reviewed
Sep 30, 2016
| @@ -395,11 +395,11 @@ The following parameters can be specified to setup the controller: | |||
|
|
|||
| #### Huge page limits | |||
|
|
|||
| `hugepageLimits` represents the `hugetlb` controller which allows to limit the | |||
| **`hugepageLimits`** (array, OPTIONAL) represents the `hugetlb` controller which allows to limit the | |||
There was a problem hiding this comment.
“array” → “array of objects”.
wking
reviewed
Sep 30, 2016
| HugeTLB usage per control group and enforces the controller limit during page fault. | ||
| For more information, see the [kernel cgroups documentation about HugeTLB][cgroup-v1-hugetlb]. | ||
|
|
||
| `hugepageLimits` is an array of entries, each having the following structure: | ||
| **`hugepageLimits`** is an array of entries, each having the following structure: |
There was a problem hiding this comment.
And now that we've covered the array-ness above, this can be reduced to:
Each entry has the following properties:
wking
reviewed
Sep 30, 2016
| @@ -564,7 +565,8 @@ Its value is either slave, private, or shared. | |||
|
|
|||
| ## Readonly Paths | |||
|
|
|||
| `readonlyPaths` will set the provided paths as readonly inside the container. | |||
| **`readonlyPaths`** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container. | |||
| The values MUST be absolute paths. | |||
There was a problem hiding this comment.
Maybe “…MUST be absolute paths in the container mount namespace.”
…eadonly paths Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
Mashimiao
force-pushed
the
config-fix-and-value-require-paths
branch
from
807c66f
to
25f44dd
Compare
|
@wking all mentioned fixed. |
|
25f44dd looks good to me :).
|
|
ping @opencontainers/runtime-spec-maintainers |
|
LGTM |
1 similar comment
|
LGTM |
wking
added a commit
to wking/opencontainer-runtime-spec
that referenced
this pull request
Sep 28, 2017
The old language is from 72cbff6 (config-linux.md: clearly require absolute path for namespace, 2017-03-10, opencontainers#720), but without RFC 2119 language in the absolute path wording, it's not a compliance requirement (per spec.md's "compliant" definition). This commit adjusts the language to bring it in line with our current wording for maskedPaths and readonlyPaths, which we've had since 25f44dd ( config-linux: fix format and definitely require value of masked and readonly paths, 2016-09-30, opencontainers#587). Signed-off-by: W. Trevor King <wking@tremily.us>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…eadonly paths
Signed-off-by: Ma Shimiao mashimiao.fnst@cn.fujitsu.com